<<<<<<< HEAD 3. 注释和帮助 — Python新全栈教程 1.0 文档

3. 注释和帮助

3.1. Hello World

根据学计算机的行规,第一行我们一定要打印Hello world,我们尝试在jupyter notebook里输入以下内容后运行,得出以下结果:

JupyterNotebook的简单使用在习题课里给大家做了讲解

 
print("Hello world") #打印hellow world出来
 
Hello world

print这个函数或者功能是把它括号中的内容打印到屏幕上,同理,我们可以把我们的校训也打印出来,效果如下:

 
print("我爱王晓静") #打印北京图灵学院的校训
 
我爱王晓静

3.2. 注释

  • 给程序员看到一些内容为注释

  • 机器不去执行注释内容

  • 注释一般用自然语言书写

  • 注释的分类:

    • 行注释: 以井号开头,可以单独行,也可以在某行代码后边

    • 块注释: 好几行代码或者内容,以三个连续单引号或双引号开始和结束,中间任何内容机器都忽略

    • 函数和类注释: 在函数或类定义下面之间使用块注释

# 本行是怕你们不理解特意加上的,打印出的内容是我们的校训
# 北京图灵学院的校训就是“我爱王晓静”
print("我爱王晓静,也爱北京图灵学院") # 内容不多也可以放在这里

"""
这一大堆内容都是给你们说的话
我太爱你们了
说起来就没完
可以有好多行
""" 

def hello_world():
    '''这个函数主要作用是打印出helloworld 
    同时演示函数内的注释
    '''
    print('Hello world')

执行结果如下,并没有输出注释的内容:

我爱王晓静,也爱北京图灵学院

这一大堆内容都是给你们说的话
我太爱你们了
说起来就没完
可以有好多行

3.3. 帮助的获取

  • 对于系统提供的一些内容,包括模块,函数或者功能,我们如果不确定具体使用方法或者含义可以借助系统提供的帮助文档。

  • 一般可通过help来获取帮助,需要注意函数类等只需要把名字打出来就可以

  • 百度是最好的老师

  • 在群里(QQ群: 9990960)提问的时候需要截图,不允许贴代码,可读性太差

# 比如问我对print这个不太了解,是个啥子呢

help(print)

通过help我们可以对print的帮助文档进行显示,显示如下:

   Help on built-in function print in module builtins:

    print(...)
        print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
        
        Prints the values to a stream, or to sys.stdout by default.
        ... ...
======= 3. 注释和帮助 — Python新全栈教程 1.0 文档

3. 注释和帮助

3.1. Hello World

根据学计算机的行规,第一行我们一定要打印Hello world,我们尝试在jupyter notebook里输入以下内容后运行,得出以下结果:

JupyterNotebook的简单使用在习题课里给大家做了讲解

 
print("Hello world") #打印hellow world出来
 
Hello world

print这个函数或者功能是把它括号中的内容打印到屏幕上,同理,我们可以把我们的校训也打印出来,效果如下:

 
print("我爱王晓静") #打印北京图灵学院的校训
 
我爱王晓静

3.2. 注释

  • 给程序员看到一些内容为注释

  • 机器不去执行注释内容

  • 注释一般用自然语言书写

  • 注释的分类:

    • 行注释: 以井号开头,可以单独行,也可以在某行代码后边

    • 块注释: 好几行代码或者内容,以三个连续单引号或双引号开始和结束,中间任何内容机器都忽略

    • 函数和类注释: 在函数或类定义下面之间使用块注释

# 本行是怕你们不理解特意加上的,打印出的内容是我们的校训
# 北京图灵学院的校训就是“我爱王晓静”
print("我爱王晓静,也爱北京图灵学院") # 内容不多也可以放在这里

"""
这一大堆内容都是给你们说的话
我太爱你们了
说起来就没完
可以有好多行
""" 

def hello_world():
    '''这个函数主要作用是打印出helloworld 
    同时演示函数内的注释
    '''
    print('Hello world')

执行结果如下,并没有输出注释的内容:

我爱王晓静,也爱北京图灵学院

这一大堆内容都是给你们说的话
我太爱你们了
说起来就没完
可以有好多行

3.3. 帮助的获取

  • 对于系统提供的一些内容,包括模块,函数或者功能,我们如果不确定具体使用方法或者含义可以借助系统提供的帮助文档。

  • 一般可通过help来获取帮助,需要注意函数类等只需要把名字打出来就可以

  • 百度是最好的老师

  • 在群里(QQ群: 9990960)提问的时候需要截图,不允许贴代码,可读性太差

# 比如问我对print这个不太了解,是个啥子呢

help(print)

通过help我们可以对print的帮助文档进行显示,显示如下:

   Help on built-in function print in module builtins:

    print(...)
        print(value, ..., sep=' ', end='\n', file=sys.stdout, flush=False)
        
        Prints the values to a stream, or to sys.stdout by default.
        ... ...
>>>>>>> 8e966fc9887329c8a51c873b4ac64659b6557f12